Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert content and switch from jekyll to sphinx #38

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

lornajane
Copy link
Contributor

@lornajane lornajane commented Nov 8, 2024

A ReStructuredText project really should have rst website source! Update our content and manual to be rendered by Sphinx and published to GitHub pages. Add some dummy directives to do a "no op" for the stuff that isn't supported/needed when Sphinx renders the manual as HTML.

Things that still need sorting out:

  • Run more of the HTML build workflow on every pull request to make it easier to review
  • Test the usage instructions in the README (which possibly should be in CONTRIBUTING, now I think about that more
  • The manual pulls in content from other pages that it expects to find nearby, so we need to either bring those files here, include them in the manual, or something else

Followup tasks:

  • Automate getting updated manual rst source and PDF files from the main repo (when? On release?)

We should update the default branch to main and publish from that when we deploy this change.

@lornajane lornajane requested a review from akrabat November 8, 2024 15:26
@lornajane lornajane marked this pull request as ready for review November 8, 2024 15:26
@lornajane lornajane marked this pull request as draft November 8, 2024 16:17
@lornajane
Copy link
Contributor Author

lornajane commented Nov 29, 2024

To see how this work is progressing, grab an artifact from the build action, extract it locally and preview the site with python -m http.server. If we merge #1245 which removes external dependencies from the manual and generally makes it a bit more docs-like, the result is easier to read (that version of the manual is what's in the branch at the moment, until we automate that part!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant